<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    package org.hackystat.ui.telemetryviewer.server;<a name="line.1"></a>
<FONT color="green">002</FONT>    <a name="line.2"></a>
<FONT color="green">003</FONT>    import java.io.File;<a name="line.3"></a>
<FONT color="green">004</FONT>    import java.io.FileInputStream;<a name="line.4"></a>
<FONT color="green">005</FONT>    import java.io.FileNotFoundException;<a name="line.5"></a>
<FONT color="green">006</FONT>    import java.io.IOException;<a name="line.6"></a>
<FONT color="green">007</FONT>    import java.io.Serializable;<a name="line.7"></a>
<FONT color="green">008</FONT>    <a name="line.8"></a>
<FONT color="green">009</FONT>    import org.hackystat.ui.telemetryviewer.client.common.PropertyKeys;<a name="line.9"></a>
<FONT color="green">010</FONT>    import org.hackystat.ui.telemetryviewer.client.common.RPCException;<a name="line.10"></a>
<FONT color="green">011</FONT>    <a name="line.11"></a>
<FONT color="green">012</FONT>    /**<a name="line.12"></a>
<FONT color="green">013</FONT>     * Provides access to the Telemetry Viewer's properties file for each sensor, and provides<a name="line.13"></a>
<FONT color="green">014</FONT>     * reasonable default values when properties file lacks property values. &lt;p&gt;<a name="line.14"></a>
<FONT color="green">015</FONT>     *<a name="line.15"></a>
<FONT color="green">016</FONT>     * The creation of a Properties instance requires a valid sensor properties file. The sensor <a name="line.16"></a>
<FONT color="green">017</FONT>     * properties file is stored in userhome/.hackystat/telemetryviewer/telemetryviewer.properties.<a name="line.17"></a>
<FONT color="green">018</FONT>     * It is a user-maintained file of key=value pairs. &lt;p&gt;<a name="line.18"></a>
<FONT color="green">019</FONT>     * <a name="line.19"></a>
<FONT color="green">020</FONT>     * All of the properties in telemetryviewer.properties are added to the System property instance<a name="line.20"></a>
<FONT color="green">021</FONT>     * after being read from the file. This enables other tools that interoperate with Hackystat to <a name="line.21"></a>
<FONT color="green">022</FONT>     * obtain settings from the System instance and/or environments to configure System property <a name="line.22"></a>
<FONT color="green">023</FONT>     * settings (such as for SSL) simply by adding entries to the properties file. <a name="line.23"></a>
<FONT color="green">024</FONT>     *<a name="line.24"></a>
<FONT color="green">025</FONT>     * @author David J. Nickles, Philip M. Johnson, Aaron A. Kagawa<a name="line.25"></a>
<FONT color="green">026</FONT>     */<a name="line.26"></a>
<FONT color="green">027</FONT>    public class Properties implements Serializable {<a name="line.27"></a>
<FONT color="green">028</FONT>    <a name="line.28"></a>
<FONT color="green">029</FONT>      /** Serializable ID. */<a name="line.29"></a>
<FONT color="green">030</FONT>      private static final long serialVersionUID = 2336433135397294917L;<a name="line.30"></a>
<FONT color="green">031</FONT>      /** Polling time interval.  */<a name="line.31"></a>
<FONT color="green">032</FONT>      private static final String RELATIVE_PATH = <a name="line.32"></a>
<FONT color="green">033</FONT>        "/.hackystat/telemetryviewer/telemetryviewer.properties";<a name="line.33"></a>
<FONT color="green">034</FONT>    <a name="line.34"></a>
<FONT color="green">035</FONT>      /** The standard location of the sensor properties file. */<a name="line.35"></a>
<FONT color="green">036</FONT>      private transient File telemetryViewerFile;<a name="line.36"></a>
<FONT color="green">037</FONT>    <a name="line.37"></a>
<FONT color="green">038</FONT>      /** Whether the properties file exists and was successfully read. */<a name="line.38"></a>
<FONT color="green">039</FONT>      private boolean fileAvailable = false;<a name="line.39"></a>
<FONT color="green">040</FONT>      /** The internal properties object. */<a name="line.40"></a>
<FONT color="green">041</FONT>      private java.util.Properties telemetryViewerProps = new java.util.Properties();<a name="line.41"></a>
<FONT color="green">042</FONT>    <a name="line.42"></a>
<FONT color="green">043</FONT>      /**<a name="line.43"></a>
<FONT color="green">044</FONT>       * Initializes based on the user's telemetryviewer.properties file.<a name="line.44"></a>
<FONT color="green">045</FONT>       * @throws RPCException If the SDBProperties instance cannot be instantiated. <a name="line.45"></a>
<FONT color="green">046</FONT>       */<a name="line.46"></a>
<FONT color="green">047</FONT>      public Properties() throws RPCException {<a name="line.47"></a>
<FONT color="green">048</FONT>        this(new File(System.getProperty("user.home") + RELATIVE_PATH));<a name="line.48"></a>
<FONT color="green">049</FONT>      }<a name="line.49"></a>
<FONT color="green">050</FONT>    <a name="line.50"></a>
<FONT color="green">051</FONT>      /**<a name="line.51"></a>
<FONT color="green">052</FONT>       * Provides access to Hackystat Sensor settings by reading specified sensor properties file. <a name="line.52"></a>
<FONT color="green">053</FONT>       * @param sensorFile The sensor file to read.<a name="line.53"></a>
<FONT color="green">054</FONT>       * @throws RPCException If the Properties instance cannot be instantiated. <a name="line.54"></a>
<FONT color="green">055</FONT>       */<a name="line.55"></a>
<FONT color="green">056</FONT>      public Properties(File sensorFile) throws RPCException {<a name="line.56"></a>
<FONT color="green">057</FONT>        // validation of the sensor file<a name="line.57"></a>
<FONT color="green">058</FONT>        if (sensorFile == null) {<a name="line.58"></a>
<FONT color="green">059</FONT>          throw new RPCException("Invalid telemetryviewer properties file");<a name="line.59"></a>
<FONT color="green">060</FONT>        }<a name="line.60"></a>
<FONT color="green">061</FONT>        if (!sensorFile.exists()) {<a name="line.61"></a>
<FONT color="green">062</FONT>          throw new RPCException("Telemetryviewer properties file does not exist at "<a name="line.62"></a>
<FONT color="green">063</FONT>              + sensorFile.getAbsolutePath());<a name="line.63"></a>
<FONT color="green">064</FONT>        }<a name="line.64"></a>
<FONT color="green">065</FONT>        if (!sensorFile.isFile()) {<a name="line.65"></a>
<FONT color="green">066</FONT>          throw new RPCException("Telemetryviewer properties must be a file.");<a name="line.66"></a>
<FONT color="green">067</FONT>        }<a name="line.67"></a>
<FONT color="green">068</FONT>        if (!sensorFile.canRead()) {<a name="line.68"></a>
<FONT color="green">069</FONT>          throw new RPCException("Unable to read the telemetryviewer properties file at "<a name="line.69"></a>
<FONT color="green">070</FONT>              + sensorFile.getAbsolutePath());<a name="line.70"></a>
<FONT color="green">071</FONT>        }<a name="line.71"></a>
<FONT color="green">072</FONT>    <a name="line.72"></a>
<FONT color="green">073</FONT>        // the sensor file should be valid at this point, whether there is anything is not know yet.<a name="line.73"></a>
<FONT color="green">074</FONT>        this.telemetryViewerFile = sensorFile;<a name="line.74"></a>
<FONT color="green">075</FONT>        FileInputStream fileStream = null;<a name="line.75"></a>
<FONT color="green">076</FONT>        try {<a name="line.76"></a>
<FONT color="green">077</FONT>          fileStream = new FileInputStream(this.telemetryViewerFile);<a name="line.77"></a>
<FONT color="green">078</FONT>          this.telemetryViewerProps.load(fileStream);<a name="line.78"></a>
<FONT color="green">079</FONT>          if (this.telemetryViewerProps.size() &gt; 0) {<a name="line.79"></a>
<FONT color="green">080</FONT>            this.fileAvailable = true;<a name="line.80"></a>
<FONT color="green">081</FONT>            // Add the current set of hackystat properties to the System property object.<a name="line.81"></a>
<FONT color="green">082</FONT>            this.addToSystemProperties(this.telemetryViewerProps);<a name="line.82"></a>
<FONT color="green">083</FONT>          }<a name="line.83"></a>
<FONT color="green">084</FONT>        }<a name="line.84"></a>
<FONT color="green">085</FONT>        catch (FileNotFoundException e) {  <a name="line.85"></a>
<FONT color="green">086</FONT>          throw new RPCException("TV properties file does not exist at " // NOPMD cannot chain here<a name="line.86"></a>
<FONT color="green">087</FONT>              + sensorFile.getAbsolutePath());<a name="line.87"></a>
<FONT color="green">088</FONT>        }<a name="line.88"></a>
<FONT color="green">089</FONT>        catch (IOException e) {  //NOPMD cannot chain serializable exceptions. <a name="line.89"></a>
<FONT color="green">090</FONT>          throw new RPCException("Unable to read the TV properties file at " // NOPMD cannot chain<a name="line.90"></a>
<FONT color="green">091</FONT>              + sensorFile.getAbsolutePath());<a name="line.91"></a>
<FONT color="green">092</FONT>        }<a name="line.92"></a>
<FONT color="green">093</FONT>        finally {<a name="line.93"></a>
<FONT color="green">094</FONT>          try {<a name="line.94"></a>
<FONT color="green">095</FONT>            fileStream.close();<a name="line.95"></a>
<FONT color="green">096</FONT>          }<a name="line.96"></a>
<FONT color="green">097</FONT>          catch (Exception e) {<a name="line.97"></a>
<FONT color="green">098</FONT>            System.err.println("Error closing stream: " + e);<a name="line.98"></a>
<FONT color="green">099</FONT>          }<a name="line.99"></a>
<FONT color="green">100</FONT>        }<a name="line.100"></a>
<FONT color="green">101</FONT>      }<a name="line.101"></a>
<FONT color="green">102</FONT>    <a name="line.102"></a>
<FONT color="green">103</FONT>      /**<a name="line.103"></a>
<FONT color="green">104</FONT>       * Creates a "minimal" sensor properties file usable for test case purposes. Needed by<a name="line.104"></a>
<FONT color="green">105</FONT>       * SensorShell which must be passed a Properties object containing a host, email, and password.<a name="line.105"></a>
<FONT color="green">106</FONT>       * @param sensorbase The hackystat sensorbase host.<a name="line.106"></a>
<FONT color="green">107</FONT>       * @param telemetry The hackystat telemetry host.<a name="line.107"></a>
<FONT color="green">108</FONT>       * @param email The user's email.<a name="line.108"></a>
<FONT color="green">109</FONT>       * @param password The user's password.<a name="line.109"></a>
<FONT color="green">110</FONT>       */<a name="line.110"></a>
<FONT color="green">111</FONT>      public Properties(String sensorbase, String telemetry, String email, String password) {<a name="line.111"></a>
<FONT color="green">112</FONT>        this.telemetryViewerProps.setProperty(PropertyKeys.SENSORBASE_HOST, sensorbase);<a name="line.112"></a>
<FONT color="green">113</FONT>        this.telemetryViewerProps.setProperty(PropertyKeys.TELEMETRY_HOST, telemetry);<a name="line.113"></a>
<FONT color="green">114</FONT>        this.telemetryViewerProps.setProperty(PropertyKeys.EMAIL_KEY, email);<a name="line.114"></a>
<FONT color="green">115</FONT>        this.telemetryViewerProps.setProperty(PropertyKeys.PASSWORD_KEY, password);<a name="line.115"></a>
<FONT color="green">116</FONT>        // Add the current set of hackystat properties to the System property object.<a name="line.116"></a>
<FONT color="green">117</FONT>        this.addToSystemProperties(this.telemetryViewerProps);<a name="line.117"></a>
<FONT color="green">118</FONT>        this.fileAvailable = false;<a name="line.118"></a>
<FONT color="green">119</FONT>      }<a name="line.119"></a>
<FONT color="green">120</FONT>      <a name="line.120"></a>
<FONT color="green">121</FONT>      /**<a name="line.121"></a>
<FONT color="green">122</FONT>       * Returns the directory in which the sensor.properties file is located (if it exists). This is<a name="line.122"></a>
<FONT color="green">123</FONT>       * normally the .hackystat directory. If this Properties instance was created without a<a name="line.123"></a>
<FONT color="green">124</FONT>       * sensor.properties file, or if for some other reason the sensor.properties file cannot be<a name="line.124"></a>
<FONT color="green">125</FONT>       * found, then this method returns null.<a name="line.125"></a>
<FONT color="green">126</FONT>       *<a name="line.126"></a>
<FONT color="green">127</FONT>       * @return A File instance indicating a directory, or null.<a name="line.127"></a>
<FONT color="green">128</FONT>       */<a name="line.128"></a>
<FONT color="green">129</FONT>      public File getTelemetryViewerPropertiesDir() {<a name="line.129"></a>
<FONT color="green">130</FONT>        if ((this.telemetryViewerFile != null) &amp;&amp; (this.telemetryViewerFile.exists())) {<a name="line.130"></a>
<FONT color="green">131</FONT>          return this.telemetryViewerFile.getParentFile();<a name="line.131"></a>
<FONT color="green">132</FONT>        }<a name="line.132"></a>
<FONT color="green">133</FONT>        else {<a name="line.133"></a>
<FONT color="green">134</FONT>          return null;<a name="line.134"></a>
<FONT color="green">135</FONT>        }<a name="line.135"></a>
<FONT color="green">136</FONT>      }<a name="line.136"></a>
<FONT color="green">137</FONT>      <a name="line.137"></a>
<FONT color="green">138</FONT>      /**<a name="line.138"></a>
<FONT color="green">139</FONT>       * Returns the trimmed property value associated with the property key in this <a name="line.139"></a>
<FONT color="green">140</FONT>       * v8.sensor.properties file. In most cases, it is recommended that clients use the access <a name="line.140"></a>
<FONT color="green">141</FONT>       * methods like &lt;code&gt;getHackystatHost()&lt;/code&gt;, because these methods provide default values.<a name="line.141"></a>
<FONT color="green">142</FONT>       * @param key The parameter key.<a name="line.142"></a>
<FONT color="green">143</FONT>       * @return The trimmed property value associated with this property key, or null if not found.<a name="line.143"></a>
<FONT color="green">144</FONT>       */<a name="line.144"></a>
<FONT color="green">145</FONT>      public String getProperty(String key) {<a name="line.145"></a>
<FONT color="green">146</FONT>        String value = this.telemetryViewerProps.getProperty(key);<a name="line.146"></a>
<FONT color="green">147</FONT>        if (value != null) {<a name="line.147"></a>
<FONT color="green">148</FONT>          value = value.trim();<a name="line.148"></a>
<FONT color="green">149</FONT>        }<a name="line.149"></a>
<FONT color="green">150</FONT>        return value;<a name="line.150"></a>
<FONT color="green">151</FONT>      }<a name="line.151"></a>
<FONT color="green">152</FONT>    <a name="line.152"></a>
<FONT color="green">153</FONT>      /**<a name="line.153"></a>
<FONT color="green">154</FONT>       * Returns the hackystat sensorbase host. Defaults to http://localhost/.<a name="line.154"></a>
<FONT color="green">155</FONT>       * @return The hackystat sensorbase host.<a name="line.155"></a>
<FONT color="green">156</FONT>       */<a name="line.156"></a>
<FONT color="green">157</FONT>      public String getSensorbaseHost() {<a name="line.157"></a>
<FONT color="green">158</FONT>        String host = this.telemetryViewerProps.getProperty(PropertyKeys.SENSORBASE_HOST, <a name="line.158"></a>
<FONT color="green">159</FONT>          "http://localhost/").trim(); <a name="line.159"></a>
<FONT color="green">160</FONT>        if (!host.endsWith("/")) {<a name="line.160"></a>
<FONT color="green">161</FONT>          host = host + "/";<a name="line.161"></a>
<FONT color="green">162</FONT>        }<a name="line.162"></a>
<FONT color="green">163</FONT>        return host;<a name="line.163"></a>
<FONT color="green">164</FONT>      }<a name="line.164"></a>
<FONT color="green">165</FONT>    <a name="line.165"></a>
<FONT color="green">166</FONT>      /**<a name="line.166"></a>
<FONT color="green">167</FONT>       * Returns the hackystat DailyProjectData host. Defaults to http://localhost/.<a name="line.167"></a>
<FONT color="green">168</FONT>       * @return The hackystat DailyProjectData host.<a name="line.168"></a>
<FONT color="green">169</FONT>       */<a name="line.169"></a>
<FONT color="green">170</FONT>      public String getDPDHost() {<a name="line.170"></a>
<FONT color="green">171</FONT>        String host = this.telemetryViewerProps.getProperty(PropertyKeys.DAILYPROJECTDATA_HOST, <a name="line.171"></a>
<FONT color="green">172</FONT>          "http://localhost/").trim(); <a name="line.172"></a>
<FONT color="green">173</FONT>        if (!host.endsWith("/")) {<a name="line.173"></a>
<FONT color="green">174</FONT>          host = host + "/";<a name="line.174"></a>
<FONT color="green">175</FONT>        }<a name="line.175"></a>
<FONT color="green">176</FONT>        return host;<a name="line.176"></a>
<FONT color="green">177</FONT>      }<a name="line.177"></a>
<FONT color="green">178</FONT>    <a name="line.178"></a>
<FONT color="green">179</FONT>      /**<a name="line.179"></a>
<FONT color="green">180</FONT>       * Returns the hackystat telemetry host. Defaults to http://localhost/.<a name="line.180"></a>
<FONT color="green">181</FONT>       * @return The hackystat telemetry host.<a name="line.181"></a>
<FONT color="green">182</FONT>       */<a name="line.182"></a>
<FONT color="green">183</FONT>      public String getTelemetryHost() {<a name="line.183"></a>
<FONT color="green">184</FONT>        String host = this.telemetryViewerProps.getProperty(PropertyKeys.TELEMETRY_HOST, <a name="line.184"></a>
<FONT color="green">185</FONT>          "http://localhost/").trim(); <a name="line.185"></a>
<FONT color="green">186</FONT>        if (!host.endsWith("/")) {<a name="line.186"></a>
<FONT color="green">187</FONT>          host = host + "/";<a name="line.187"></a>
<FONT color="green">188</FONT>        }<a name="line.188"></a>
<FONT color="green">189</FONT>        return host;<a name="line.189"></a>
<FONT color="green">190</FONT>      }<a name="line.190"></a>
<FONT color="green">191</FONT>    <a name="line.191"></a>
<FONT color="green">192</FONT>    <a name="line.192"></a>
<FONT color="green">193</FONT>      /**<a name="line.193"></a>
<FONT color="green">194</FONT>       * Returns the absolute path to the properties file, or the empty string if the file is not<a name="line.194"></a>
<FONT color="green">195</FONT>       * available.<a name="line.195"></a>
<FONT color="green">196</FONT>       * @return The absolutePath value or the empty string.<a name="line.196"></a>
<FONT color="green">197</FONT>       */<a name="line.197"></a>
<FONT color="green">198</FONT>      public String getAbsolutePath() {<a name="line.198"></a>
<FONT color="green">199</FONT>        return (this.telemetryViewerFile == null) ? "" : this.telemetryViewerFile.getAbsolutePath();<a name="line.199"></a>
<FONT color="green">200</FONT>      }<a name="line.200"></a>
<FONT color="green">201</FONT>    <a name="line.201"></a>
<FONT color="green">202</FONT>    <a name="line.202"></a>
<FONT color="green">203</FONT>      /**<a name="line.203"></a>
<FONT color="green">204</FONT>       * Returns the password for this user. Defaults to "ChangeThis"<a name="line.204"></a>
<FONT color="green">205</FONT>       * @return The user password.<a name="line.205"></a>
<FONT color="green">206</FONT>       */<a name="line.206"></a>
<FONT color="green">207</FONT>      public String getPassword() {<a name="line.207"></a>
<FONT color="green">208</FONT>        return this.telemetryViewerProps.getProperty(PropertyKeys.PASSWORD_KEY, "ChangeThis").trim();<a name="line.208"></a>
<FONT color="green">209</FONT>      }<a name="line.209"></a>
<FONT color="green">210</FONT>    <a name="line.210"></a>
<FONT color="green">211</FONT>      /**<a name="line.211"></a>
<FONT color="green">212</FONT>       * Returns the email for this user. Defaults to "ChangeThis@changethis.com"<a name="line.212"></a>
<FONT color="green">213</FONT>       * @return The user email.<a name="line.213"></a>
<FONT color="green">214</FONT>       */<a name="line.214"></a>
<FONT color="green">215</FONT>      public String getEmail() {<a name="line.215"></a>
<FONT color="green">216</FONT>        return this.telemetryViewerProps.getProperty(PropertyKeys.EMAIL_KEY, <a name="line.216"></a>
<FONT color="green">217</FONT>          "ChangeThis@changethis.com").trim();<a name="line.217"></a>
<FONT color="green">218</FONT>      }<a name="line.218"></a>
<FONT color="green">219</FONT>    <a name="line.219"></a>
<FONT color="green">220</FONT>      /**<a name="line.220"></a>
<FONT color="green">221</FONT>       * Returns true if the sensor properties file was found and read successfully.<a name="line.221"></a>
<FONT color="green">222</FONT>       * @return True if file was found and readable.<a name="line.222"></a>
<FONT color="green">223</FONT>       */<a name="line.223"></a>
<FONT color="green">224</FONT>      public boolean isFileAvailable() {<a name="line.224"></a>
<FONT color="green">225</FONT>        return this.fileAvailable;<a name="line.225"></a>
<FONT color="green">226</FONT>      }<a name="line.226"></a>
<FONT color="green">227</FONT>    <a name="line.227"></a>
<FONT color="green">228</FONT>      /**<a name="line.228"></a>
<FONT color="green">229</FONT>       * Updates the System properties object with the contents of the passed Hackystat<a name="line.229"></a>
<FONT color="green">230</FONT>       * properties instance.  This method is declared static so that it can be invoked<a name="line.230"></a>
<FONT color="green">231</FONT>       * from both Properties and ServerProperties.  The hackystat properties added from<a name="line.231"></a>
<FONT color="green">232</FONT>       * Properties were found in sensor.properties. The hackystat properties added from<a name="line.232"></a>
<FONT color="green">233</FONT>       * ServerProperties were found in hackystat.server.properties.  <a name="line.233"></a>
<FONT color="green">234</FONT>       * This method is package-private for access by Properties.<a name="line.234"></a>
<FONT color="green">235</FONT>       * @param hackyProperties A Properties instance containing hackystat properties.<a name="line.235"></a>
<FONT color="green">236</FONT>       */<a name="line.236"></a>
<FONT color="green">237</FONT>      private void addToSystemProperties(java.util.Properties hackyProperties) {<a name="line.237"></a>
<FONT color="green">238</FONT>        java.util.Properties systemProperties = System.getProperties();<a name="line.238"></a>
<FONT color="green">239</FONT>        systemProperties.putAll(hackyProperties);<a name="line.239"></a>
<FONT color="green">240</FONT>        System.setProperties(systemProperties);<a name="line.240"></a>
<FONT color="green">241</FONT>      }<a name="line.241"></a>
<FONT color="green">242</FONT>    }<a name="line.242"></a>
<FONT color="green">243</FONT>    <a name="line.243"></a>




























































</PRE>
</BODY>
</HTML>
